<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GstRTSPPermissions: GStreamer RTSP Server Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="GStreamer RTSP Server Reference Manual">
<link rel="up" href="ch01.html" title="">
<link rel="prev" href="GstRTSPToken.html" title="GstRTSPToken">
<link rel="next" href="gst-rtsp-server-GstRTSPParams.html" title="GstRTSPParams">
<meta name="generator" content="GTK-Doc V1.25 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#GstRTSPPermissions.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
                  <a href="#GstRTSPPermissions.object-hierarchy" class="shortcut">Object Hierarchy</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="GstRTSPToken.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="gst-rtsp-server-GstRTSPParams.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="GstRTSPPermissions"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GstRTSPPermissions.top_of_page"></a>GstRTSPPermissions</span></h2>
<p>GstRTSPPermissions — Roles and associated permissions</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="GstRTSPPermissions.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="GstRTSPPermissions.html" title="GstRTSPPermissions"><span class="returnvalue">GstRTSPPermissions</span></a> *
</td>
<td class="function_name">
<a class="link" href="GstRTSPPermissions.html#gst-rtsp-permissions-new" title="gst_rtsp_permissions_new ()">gst_rtsp_permissions_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="GstRTSPPermissions.html" title="GstRTSPPermissions"><span class="returnvalue">GstRTSPPermissions</span></a> *
</td>
<td class="function_name">
<a class="link" href="GstRTSPPermissions.html#gst-rtsp-permissions-ref" title="gst_rtsp_permissions_ref ()">gst_rtsp_permissions_ref</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GstRTSPPermissions.html#gst-rtsp-permissions-unref" title="gst_rtsp_permissions_unref ()">gst_rtsp_permissions_unref</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GstRTSPPermissions.html#gst-rtsp-permissions-add-role" title="gst_rtsp_permissions_add_role ()">gst_rtsp_permissions_add_role</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GstRTSPPermissions.html#gst-rtsp-permissions-add-role-valist" title="gst_rtsp_permissions_add_role_valist ()">gst_rtsp_permissions_add_role_valist</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GstRTSPPermissions.html#gst-rtsp-permissions-remove-role" title="gst_rtsp_permissions_remove_role ()">gst_rtsp_permissions_remove_role</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <a href="/usr/share/gtk-doc/html/gstreamer-1.0GstStructure.html#GstStructure-struct"><span class="returnvalue">GstStructure</span></a> *
</td>
<td class="function_name">
<a class="link" href="GstRTSPPermissions.html#gst-rtsp-permissions-get-role" title="gst_rtsp_permissions_get_role ()">gst_rtsp_permissions_get_role</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="GstRTSPPermissions.html#gst-rtsp-permissions-is-allowed" title="gst_rtsp_permissions_is_allowed ()">gst_rtsp_permissions_is_allowed</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GstRTSPPermissions.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody><tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="GstRTSPPermissions.html#GstRTSPPermissions-struct" title="struct GstRTSPPermissions">GstRTSPPermissions</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GstRTSPPermissions.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    <a href="https://developer.gnome.org/gobject/unstable/gobject-Boxed-Types.html">GBoxed</a>
    <span class="lineart">╰──</span> GstRTSPPermissions
</pre>
</div>
<div class="refsect1">
<a name="GstRTSPPermissions.description"></a><h2>Description</h2>
<p>The <a class="link" href="GstRTSPPermissions.html" title="GstRTSPPermissions"><span class="type">GstRTSPPermissions</span></a> object contains an array of roles and associated
permissions. The roles are represented with a string and the permissions with
a generic <a href="/usr/share/gtk-doc/html/gstreamer-1.0GstStructure.html#GstStructure-struct"><span class="type">GstStructure</span></a>.</p>
<p>The permissions are deliberately kept generic. The possible values of the
roles and <a href="/usr/share/gtk-doc/html/gstreamer-1.0GstStructure.html#GstStructure-struct"><span class="type">GstStructure</span></a> keys and values are only determined by the <a class="link" href="GstRTSPAuth.html" title="GstRTSPAuth"><span class="type">GstRTSPAuth</span></a>
object that performs the checks on the permissions and the current
<a class="link" href="GstRTSPToken.html" title="GstRTSPToken"><span class="type">GstRTSPToken</span></a>.</p>
<p>As a convenience function, <a class="link" href="GstRTSPPermissions.html#gst-rtsp-permissions-is-allowed" title="gst_rtsp_permissions_is_allowed ()"><code class="function">gst_rtsp_permissions_is_allowed()</code></a> can be used to
check if the permissions contains a role that contains the boolean value
<a href="/usr/share/gtk-doc/html/glibglib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> for the the given key.</p>
<p>Last reviewed on 2013-07-15 (1.0.0)</p>
</div>
<div class="refsect1">
<a name="GstRTSPPermissions.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gst-rtsp-permissions-new"></a><h3>gst_rtsp_permissions_new ()</h3>
<pre class="programlisting"><a class="link" href="GstRTSPPermissions.html" title="GstRTSPPermissions"><span class="returnvalue">GstRTSPPermissions</span></a> *
gst_rtsp_permissions_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Create a new empty Authorization permissions.</p>
<div class="refsect3">
<a name="gst-rtsp-permissions-new.returns"></a><h4>Returns</h4>
<p> a new empty authorization permissions. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gst-rtsp-permissions-ref"></a><h3>gst_rtsp_permissions_ref ()</h3>
<pre class="programlisting"><a class="link" href="GstRTSPPermissions.html" title="GstRTSPPermissions"><span class="returnvalue">GstRTSPPermissions</span></a> *
gst_rtsp_permissions_ref (<em class="parameter"><code><a class="link" href="GstRTSPPermissions.html" title="GstRTSPPermissions"><span class="type">GstRTSPPermissions</span></a> *permissions</code></em>);</pre>
<p>Increase the refcount of this permissions.</p>
<div class="refsect3">
<a name="gst-rtsp-permissions-ref.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>permissions</p></td>
<td class="parameter_description"><p>The permissions to refcount</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gst-rtsp-permissions-ref.returns"></a><h4>Returns</h4>
<p> <em class="parameter"><code>permissions</code></em>
(for convenience when doing assignments). </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gst-rtsp-permissions-unref"></a><h3>gst_rtsp_permissions_unref ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gst_rtsp_permissions_unref (<em class="parameter"><code><a class="link" href="GstRTSPPermissions.html" title="GstRTSPPermissions"><span class="type">GstRTSPPermissions</span></a> *permissions</code></em>);</pre>
<p>Decrease the refcount of an permissions, freeing it if the refcount reaches 0.</p>
<div class="refsect3">
<a name="gst-rtsp-permissions-unref.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>permissions</p></td>
<td class="parameter_description"><p> the permissions to refcount. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gst-rtsp-permissions-add-role"></a><h3>gst_rtsp_permissions_add_role ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gst_rtsp_permissions_add_role (<em class="parameter"><code><a class="link" href="GstRTSPPermissions.html" title="GstRTSPPermissions"><span class="type">GstRTSPPermissions</span></a> *permissions</code></em>,
                               <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *role</code></em>,
                               <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *fieldname</code></em>,
                               <em class="parameter"><code>...</code></em>);</pre>
<p>Add a new <em class="parameter"><code>role</code></em>
 to <em class="parameter"><code>permissions</code></em>
 with the given variables. The fields
are the same layout as <a href="/usr/share/gtk-doc/html/gstreamer-1.0GstStructure.html#gst-structure-new"><code class="function">gst_structure_new()</code></a>.</p>
<div class="refsect3">
<a name="gst-rtsp-permissions-add-role.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>permissions</p></td>
<td class="parameter_description"><p>a <a class="link" href="GstRTSPPermissions.html" title="GstRTSPPermissions"><span class="type">GstRTSPPermissions</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>role</p></td>
<td class="parameter_description"><p>a role</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>fieldname</p></td>
<td class="parameter_description"><p>the first field name</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>...</p></td>
<td class="parameter_description"><p>additional arguments</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gst-rtsp-permissions-add-role-valist"></a><h3>gst_rtsp_permissions_add_role_valist ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gst_rtsp_permissions_add_role_valist (<em class="parameter"><code><a class="link" href="GstRTSPPermissions.html" title="GstRTSPPermissions"><span class="type">GstRTSPPermissions</span></a> *permissions</code></em>,
                                      <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *role</code></em>,
                                      <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *fieldname</code></em>,
                                      <em class="parameter"><code><span class="type">va_list</span> var_args</code></em>);</pre>
<p>Add a new <em class="parameter"><code>role</code></em>
 to <em class="parameter"><code>permissions</code></em>
 with the given variables. Structure fields
are set according to the varargs in a manner similar to <a href="/usr/share/gtk-doc/html/gstreamer-1.0GstStructure.html#gst-structure-new"><code class="function">gst_structure_new()</code></a>.</p>
<div class="refsect3">
<a name="gst-rtsp-permissions-add-role-valist.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>permissions</p></td>
<td class="parameter_description"><p>a <a class="link" href="GstRTSPPermissions.html" title="GstRTSPPermissions"><span class="type">GstRTSPPermissions</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>role</p></td>
<td class="parameter_description"><p>a role</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>fieldname</p></td>
<td class="parameter_description"><p>the first field name</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>var_args</p></td>
<td class="parameter_description"><p>additional fields to add</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gst-rtsp-permissions-remove-role"></a><h3>gst_rtsp_permissions_remove_role ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gst_rtsp_permissions_remove_role (<em class="parameter"><code><a class="link" href="GstRTSPPermissions.html" title="GstRTSPPermissions"><span class="type">GstRTSPPermissions</span></a> *permissions</code></em>,
                                  <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *role</code></em>);</pre>
<p>Remove all permissions for <em class="parameter"><code>role</code></em>
 in <em class="parameter"><code>permissions</code></em>
.</p>
<div class="refsect3">
<a name="gst-rtsp-permissions-remove-role.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>permissions</p></td>
<td class="parameter_description"><p>a <a class="link" href="GstRTSPPermissions.html" title="GstRTSPPermissions"><span class="type">GstRTSPPermissions</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>role</p></td>
<td class="parameter_description"><p>a role</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gst-rtsp-permissions-get-role"></a><h3>gst_rtsp_permissions_get_role ()</h3>
<pre class="programlisting">const <a href="/usr/share/gtk-doc/html/gstreamer-1.0GstStructure.html#GstStructure-struct"><span class="returnvalue">GstStructure</span></a> *
gst_rtsp_permissions_get_role (<em class="parameter"><code><a class="link" href="GstRTSPPermissions.html" title="GstRTSPPermissions"><span class="type">GstRTSPPermissions</span></a> *permissions</code></em>,
                               <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *role</code></em>);</pre>
<p>Get all permissions for <em class="parameter"><code>role</code></em>
 in <em class="parameter"><code>permissions</code></em>
.</p>
<div class="refsect3">
<a name="gst-rtsp-permissions-get-role.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>permissions</p></td>
<td class="parameter_description"><p>a <a class="link" href="GstRTSPPermissions.html" title="GstRTSPPermissions"><span class="type">GstRTSPPermissions</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>role</p></td>
<td class="parameter_description"><p>a role</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gst-rtsp-permissions-get-role.returns"></a><h4>Returns</h4>
<p> the structure with permissions for <em class="parameter"><code>role</code></em>
. It
remains valid for as long as <em class="parameter"><code>permissions</code></em>
is valid. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gst-rtsp-permissions-is-allowed"></a><h3>gst_rtsp_permissions_is_allowed ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
gst_rtsp_permissions_is_allowed (<em class="parameter"><code><a class="link" href="GstRTSPPermissions.html" title="GstRTSPPermissions"><span class="type">GstRTSPPermissions</span></a> *permissions</code></em>,
                                 <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *role</code></em>,
                                 <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *permission</code></em>);</pre>
<p>Check if <em class="parameter"><code>role</code></em>
 in <em class="parameter"><code>permissions</code></em>
 is given permission for <em class="parameter"><code>permission</code></em>
.</p>
<div class="refsect3">
<a name="gst-rtsp-permissions-is-allowed.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>permissions</p></td>
<td class="parameter_description"><p>a <a class="link" href="GstRTSPPermissions.html" title="GstRTSPPermissions"><span class="type">GstRTSPPermissions</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>role</p></td>
<td class="parameter_description"><p>a role</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>permission</p></td>
<td class="parameter_description"><p>a permission</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gst-rtsp-permissions-is-allowed.returns"></a><h4>Returns</h4>
<p> <a href="/usr/share/gtk-doc/html/glibglib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <em class="parameter"><code>role</code></em>
is allowed <em class="parameter"><code>permission</code></em>
.</p>
</div>
</div>
</div>
<div class="refsect1">
<a name="GstRTSPPermissions.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GstRTSPPermissions-struct"></a><h3>struct GstRTSPPermissions</h3>
<pre class="programlisting">struct GstRTSPPermissions {
  GstMiniObject mini_object;
};
</pre>
<p>The opaque permissions structure. It is used to define the permissions
of objects in different roles.</p>
</div>
</div>
<div class="refsect1">
<a name="GstRTSPPermissions.see-also"></a><h2>See Also</h2>
<p><a class="link" href="GstRTSPToken.html" title="GstRTSPToken"><span class="type">GstRTSPToken</span></a>, <a class="link" href="GstRTSPAuth.html" title="GstRTSPAuth"><span class="type">GstRTSPAuth</span></a></p>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.25</div>
</body>
</html>